Kanzi 4.0.0-beta2
kanzi::gfx::SamplerCreateInfo Struct Reference

Creation information for a sampler. More...

#include <kanzi/gfx/create_info.hpp>

Inheritance diagram for kanzi::gfx::SamplerCreateInfo:
[legend]

Public Types

using HandleType
 Sampler handle.
 

Public Attributes

AddressMode addressModeU
 Defines the addressing mode for the U coordinate.
 
AddressMode addressModeV
 Defines the addressing mode for the V coordinate.
 
AddressMode addressModeW
 Defines the addressing mode for the W coordinate.
 
ColorClearValue borderColor
 Defines the border color to use when one of the address modes is AddressMode::ClampBorder.
 
ComparisonFunction comparison
 Defines the depth comparison function.
 
bool comparisonEnabled
 Defines if the depth comparison function is enabled.
 
FilterMode magFilter
 Defines the magnification filter.
 
float maxAnisotropy
 Defines the maximum anisotropy.
 
float maxLod
 Defines the max lod level.
 
FilterMode minFilter
 Defines the minification filter.
 
float minLod
 Defines the min lod level.
 
float mipLodBias
 Defines the lod bias.
 
MipMapMode mipMapFilter
 Defines the mipmap filter.
 
- Public Attributes inherited from kanzi::gfx::BaseCreateInfo
string_view name
 The name of the graphics object, useful for debugging.
 

Detailed Description

Creation information for a sampler.

A sampler describes how a shader reads a pixel from an image.

Since
Kanzi 4.0.0

Member Typedef Documentation

◆ HandleType

Member Data Documentation

◆ minFilter

FilterMode kanzi::gfx::SamplerCreateInfo::minFilter

Defines the minification filter.

◆ magFilter

FilterMode kanzi::gfx::SamplerCreateInfo::magFilter

Defines the magnification filter.

◆ mipMapFilter

MipMapMode kanzi::gfx::SamplerCreateInfo::mipMapFilter

Defines the mipmap filter.

◆ addressModeU

AddressMode kanzi::gfx::SamplerCreateInfo::addressModeU

Defines the addressing mode for the U coordinate.

◆ addressModeV

AddressMode kanzi::gfx::SamplerCreateInfo::addressModeV

Defines the addressing mode for the V coordinate.

◆ addressModeW

AddressMode kanzi::gfx::SamplerCreateInfo::addressModeW

Defines the addressing mode for the W coordinate.

◆ comparisonEnabled

bool kanzi::gfx::SamplerCreateInfo::comparisonEnabled

Defines if the depth comparison function is enabled.

◆ comparison

ComparisonFunction kanzi::gfx::SamplerCreateInfo::comparison

Defines the depth comparison function.

◆ borderColor

ColorClearValue kanzi::gfx::SamplerCreateInfo::borderColor

Defines the border color to use when one of the address modes is AddressMode::ClampBorder.

◆ maxAnisotropy

float kanzi::gfx::SamplerCreateInfo::maxAnisotropy

Defines the maximum anisotropy.

◆ mipLodBias

float kanzi::gfx::SamplerCreateInfo::mipLodBias

Defines the lod bias.

◆ minLod

float kanzi::gfx::SamplerCreateInfo::minLod

Defines the min lod level.

◆ maxLod

float kanzi::gfx::SamplerCreateInfo::maxLod

Defines the max lod level.


The documentation for this struct was generated from the following file: